com.highdeal.pnr.hci
Class ChargeSnapshotHolderModel

java.lang.Object
  com.highdeal.pnr.hci.ChargeSnapshotHolderModel

All Implemented Interfaces:

XMLMarshallable

public class ChargeSnapshotHolderModel
extends java.lang.Object
implements XMLMarshallable

This class represents a charge activation inside a subscription snapshot holder, and contains the list of included counters.

It contains the following information:

• The code of the charge activation.
• The status of the charge activation.
• The last activation date of the charge activation.

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="chargeSnapshotHolder">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="counter" minOccurs="0" maxOccurs="unbounded" />
     </xs:sequence>
     <xs:attribute name="code" type="xs:string" />
     <xs:attribute name="status" type="CAStatusType" />
     <xs:attribute name="lastActivationDate" type="xs:dateTime" />
   </xs:complexType>
 </xs:element>

Field Summary

static java.lang.String

MODEL_NAME The name of the object.

Constructor Summary

ChargeSnapshotHolderModel()
Builds an empty ChargeSnapshotHolderModel.

ChargeSnapshotHolderModel(java.lang.String chargeCode)
Builds a ChargeSnapshotHolderModel with a charge activation code.

Method Summary

void	addCharacterData(java.lang.String cData) Adds character data to the content element.
void	addChild(java.lang.String tagName, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
void	addCounter(CounterModel counter) Add a counter to the snapshot holder
java.lang.String	getCode() Gets the code of the associated charge activation.
java.util.List<CounterModel>	getCounters() Gets the list of counters contained in the snapshot holder.
java.util.Date	getLastActivationDate() Gets the last activation date stored for the associated charge activation.
java.lang.String	getStatus() Gets the status stored for the associated charge activation.
void	marshal(XMLOutputter output) Gives an XML representation of this object, including its children.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.
void	setCode(java.lang.String code) Sets the code of the associated charge activation.
void	setCounters(java.util.List<CounterModel> counters) Sets the list of counters contained in the snapshot holder.
void	setLastActivationDate(java.util.Date lastActivationDate) Sets the last activation date stored for the associated charge activation.
void	setStatus(java.lang.String status) Sets the status stored for the associated charge activation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MODEL_NAME

public static final java.lang.String MODEL_NAME

The name of the object.

See Also:

Constant Field Values

Constructor Detail

ChargeSnapshotHolderModel

public ChargeSnapshotHolderModel()

Builds an empty ChargeSnapshotHolderModel.

ChargeSnapshotHolderModel

public ChargeSnapshotHolderModel(java.lang.String chargeCode)

Builds a ChargeSnapshotHolderModel with a charge activation code.

Parameters:

chargeCode - the code of a charge activation

Method Detail

getCode

public java.lang.String getCode()

Gets the code of the associated charge activation.

Returns:

the code of the associated charge activation

setCode

public void setCode(java.lang.String code)

Sets the code of the associated charge activation.

Parameters:

code - the code of the associated charge activation

getStatus

public java.lang.String getStatus()

Gets the status stored for the associated charge activation. Possible values:

• ChargeActivationModel.NEVER_ACTIVATED_STR
• ChargeActivationModel.ACTIVE_STR
• ChargeActivationModel.SUSPENDED_STR
• ChargeActivationModel.CANCELLED_STR
• ChargeActivationModel.EARLY_CANCELLED_STR
• ChargeActivationModel.EXPIRED_STR

Returns:

the status stored for the associated charge activation

setStatus

public void setStatus(java.lang.String status)

Sets the status stored for the associated charge activation. Possible values:

• ChargeActivationModel.NEVER_ACTIVATED_STR
• ChargeActivationModel.ACTIVE_STR
• ChargeActivationModel.SUSPENDED_STR
• ChargeActivationModel.CANCELLED_STR
• ChargeActivationModel.EARLY_CANCELLED_STR
• ChargeActivationModel.EXPIRED_STR

Parameters:

status - the status to store for the associated charge activation

getLastActivationDate

public java.util.Date getLastActivationDate()

Gets the last activation date stored for the associated charge activation.

Returns:

the last activation date stored for the associated charge activation

setLastActivationDate

public void setLastActivationDate(java.util.Date lastActivationDate)

Sets the last activation date stored for the associated charge activation.

Parameters:

lastActivationDate - the last activation date to store for the associated charge activation

getCounters

public java.util.List<CounterModel> getCounters()

Gets the list of counters contained in the snapshot holder.

Returns:

the list of counters contained in the snapshot holder

setCounters

public void setCounters(java.util.List<CounterModel> counters)

Sets the list of counters contained in the snapshot holder.

Parameters:

counters - the list of counters contained in the snapshot holder

addCounter

public void addCounter(CounterModel counter)

Add a counter to the snapshot holder

Parameters:

counter - the counter to add to the snasphot holder

addCharacterData

public void addCharacterData(java.lang.String cData)

Description copied from interface: XMLMarshallable

Adds character data to the content element.

Specified by:

addCharacterData in interface XMLMarshallable

Parameters:

cData - The character data to be added

addChild

public void addChild(java.lang.String tagName,
                     XMLMarshallable child)

Description copied from interface: XMLMarshallable

Adds a child to the object, the child representing the marshallable object which must be added to the element.

Specified by:

addChild in interface XMLMarshallable

Parameters:

tagName - The name of tag for the child

child - The child to be added

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

Sets the attributes of the XML representation of the element being processed.

Specified by:

setAttributes in interface XMLMarshallable

Parameters:

atts - The XML attributes of the current element

marshal

public void marshal(XMLOutputter output)

Description copied from interface: XMLMarshallable

Gives an XML representation of this object, including its children.

Specified by:

marshal in interface XMLMarshallable

Parameters:

output - The XML output to marshal the object into